Appearance
Ingest recording events over WebSocket
GET
/recordings/{recordingId}/ingest/ws
Stream recording payloads over a WebSocket connection. This is the default method used in our JavaScript SDK. See WebSocket Ingest for more details, or use the HTTP ingest route for a simpler method.
Authorizations
Public API Key
Public API key for authentication.
TypeHTTP (bearer)
Example
"Bearer ak_1Q8AX5B5218353Q1AQNF2129YH5VAH02"or
Signature|Expires|KeyId + +
Signature
Signature for authentication. Use your presigned URL as the query parameters.
TypeAPI Key (query: signature)
Expires
Expiration timestamp (UNIX seconds)
TypeAPI Key (query: expires)
KeyId
Signing key identifier
TypeAPI Key (query: keyId)
Parameters
Path Parameters
recordingId*
The recording ID
Typestring
RequiredExample
"000e8400-e00b-00d0-a716-446655440000"Format
"uuid"Query Parameters
debug
Enable debug mode
Typestring
Example
"true"contentType
Payload content type. Defaults to application/x-ndjson when omitted.
Typestring
Valid values
"application/x-ndjson""application/ndjson""application/json"Example
"application/x-ndjson"contentEncoding
Optional compression applied to the payload frames. Defaults to identity.
Typestring
Valid values
"gzip""br""zstd"Example
"gzip"Responses
WebSocket upgraded successfully.